.TH "src/hocr.h" 3 "31 Jul 2008" "Version 0.10.17" "libhocr" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/hocr.h \- libhocr main C language header. 
.SH SYNOPSIS
.br
.PP
\fC#include <ho_pixbuf.h>\fP
.br
\fC#include <ho_array.h>\fP
.br
\fC#include <ho_array_hist.h>\fP
.br
\fC#include <ho_array_stat.h>\fP
.br
\fC#include <ho_bitmap.h>\fP
.br
\fC#include <ho_bitmap_hist.h>\fP
.br
\fC#include <ho_objmap.h>\fP
.br
\fC#include <ho_layout.h>\fP
.br
\fC#include <ho_dimentions.h>\fP
.br
\fC#include <ho_segment.h>\fP
.br
\fC#include <ho_font.h>\fP
.br
\fC#include <ho_recognize.h>\fP
.br
\fC#include <ho_recognize_nikud.h>\fP
.br
\fC#include <ho_linguistics.h>\fP
.br
\fC#include <ho_string.h>\fP
.br

.SS "Defines"

.in +1c
.ti -1c
.RI "#define \fBHOCR_H\fP   1"
.br
.in -1c
.SS "Functions"

.in +1c
.ti -1c
.RI "\fBho_bitmap\fP * \fBhocr_image_processing\fP (const \fBho_pixbuf\fP *pix_in, const unsigned char scale, const unsigned char no_auto_scale, double rotate, const unsigned char no_auto_rotate, const unsigned char adaptive, const unsigned char threshold, const unsigned char a_threshold, int *progress)"
.br
.ti -1c
.RI "\fBho_layout\fP * \fBhocr_layout_analysis\fP (const \fBho_bitmap\fP *m_in, const int font_spacing_code, const int paragraph_setup, const int slicing_threshold, const int slicing_width, const int line_leeway, const unsigned char dir_ltr, int *progress)"
.br
.ti -1c
.RI "int \fBhocr_font_recognition\fP (const \fBho_layout\fP *l_page, \fBho_string\fP *s_text_out, const unsigned char html, int font_code, const unsigned char nikud, unsigned char do_linguistics, int *progress)"
.br
.ti -1c
.RI "int \fBhocr_do_ocr_fine\fP (const \fBho_pixbuf\fP *pix_in, \fBho_string\fP *s_text_out, const unsigned char scale, const unsigned char no_auto_scale, double rotate, const unsigned char no_auto_rotate, const unsigned char adaptive, const unsigned char threshold, const unsigned char a_threshold, const int font_spacing_code, const int paragraph_setup, const int slicing_threshold, const int slicing_width, const int line_leeway, const unsigned char dir_ltr, const unsigned char html, int font_code, const unsigned char nikud, const unsigned char do_linguistics, int *progress)"
.br
.ti -1c
.RI "int \fBhocr_do_ocr\fP (const \fBho_pixbuf\fP *pix_in, \fBho_string\fP *s_text_out, const unsigned char html, int font_code, const unsigned char do_linguistics, int *progress)"
.br
.ti -1c
.RI "const char * \fBhocr_get_build_string\fP ()"
.br
.ti -1c
.RI "const char * \fBhocr_get_version_string\fP ()"
.br
.in -1c
.SH "Detailed Description"
.PP 
libhocr main C language header. 

libhocr - LIBrary for Hebrew Optical Character Recognition 
.SH "Define Documentation"
.PP 
.SS "#define HOCR_H   1"
.PP
.SH "Function Documentation"
.PP 
.SS "\fBho_bitmap\fP* hocr_image_processing (const \fBho_pixbuf\fP * pix_in, const unsigned char scale, const unsigned char no_auto_scale, double rotate, const unsigned char no_auto_rotate, const unsigned char adaptive, const unsigned char threshold, const unsigned char a_threshold, int * progress)"
.PP
convert a gray pixbuf to bitmap
.PP
\fBParameters:\fP
.RS 4
\fIpix_in\fP the input \fBho_pixbuf\fP 
.br
\fIscale\fP the scale to use 
.br
\fIno_auto_scale\fP do not try to autoscale 
.br
\fIrotate\fP the rotation angle to use 
.br
\fIno_auto_rotate\fP do not try to autorotate 
.br
\fIadaptive\fP what type of thresholding to use. 0-normal,1-no,2-fine. 
.br
\fIthreshold\fP the threshold to use 0..100 (0-auto) 
.br
\fIa_threshold\fP the threshold to use for adaptive thresholding 0..100 (0-auto) 
.br
\fIprogress\fP a progress indicator 0..100 
.RE
.PP
\fBReturns:\fP
.RS 4
newly allocated gray \fBho_bitmap\fP 
.RE
.PP

.PP
Referenced by hocr::Hocr::do_image_processing().
.SS "\fBho_layout\fP* hocr_layout_analysis (const \fBho_bitmap\fP * m_in, const int font_spacing_code, const int paragraph_setup, const int slicing_threshold, const int slicing_width, const int line_leeway, const unsigned char dir_ltr, int * progress)"
.PP
new \fBho_layout\fP
.PP
\fBParameters:\fP
.RS 4
\fIm_in\fP a pointer to a text bitmap 
.br
\fIfont_spacing_code\fP -3 tight .. 0 .. 3 spaced 
.br
\fIparagraph_setup\fP free text blocks or boxed in columns 
.br
\fIslicing_threshold\fP percent of line fill to cut fonts 
.br
\fIslicing_width\fP what is a wide font 
.br
\fIdir\fP true-ltr false-rtl 
.br
\fIprogress\fP a progress indicator 0..100 
.RE
.PP
\fBReturns:\fP
.RS 4
a newly allocated and filled layout 
.RE
.PP

.PP
Referenced by hocr::Hocr::do_layout_analysis().
.SS "int hocr_font_recognition (const \fBho_layout\fP * l_page, \fBho_string\fP * s_text_out, const unsigned char html, int font_code, const unsigned char nikud, unsigned char do_linguistics, int * progress)"
.PP
fill a text buffer with fonts recognized from a page layout
.PP
\fBParameters:\fP
.RS 4
\fIl_page\fP the page layout to recognize 
.br
\fIs_text_out\fP the text buffer to fill 
.br
\fIhtml\fP output format is html 
.br
\fIfont_code\fP code for the font to use 
.br
\fInikud\fP recognize nikud in image 
.br
\fIprogress\fP a progress indicator 0..100 
.RE
.PP
\fBReturns:\fP
.RS 4
FALSE 
.RE
.PP

.PP
Referenced by hocr::Hocr::do_font_recognition().
.SS "int hocr_do_ocr_fine (const \fBho_pixbuf\fP * pix_in, \fBho_string\fP * s_text_out, const unsigned char scale, const unsigned char no_auto_scale, double rotate, const unsigned char no_auto_rotate, const unsigned char adaptive, const unsigned char threshold, const unsigned char a_threshold, const int font_spacing_code, const int paragraph_setup, const int slicing_threshold, const int slicing_width, const int line_leeway, const unsigned char dir_ltr, const unsigned char html, int font_code, const unsigned char nikud, const unsigned char do_linguistics, int * progress)"
.PP
do ocr on a pixbuf
.PP
\fBParameters:\fP
.RS 4
\fIpix_in\fP the input \fBho_pixbuf\fP 
.br
\fIs_text_out\fP the text buffer to fill 
.br
\fIscale\fP the scale to use 
.br
\fIno_auto_scale\fP do not try to autoscale 
.br
\fIrotate\fP the rotation angle to use 
.br
\fIno_auto_rotate\fP do not try to autorotate 
.br
\fIadaptive\fP what type of thresholding to use. 0-normal,1-no,2-fine. 
.br
\fIthreshold\fP the threshold to use 0..100 (0-auto) 
.br
\fIa_threshold\fP the threshold to use for adaptive thresholding 0..100 (0-auto) 
.br
\fIm_in\fP a pointer to a text bitmap 
.br
\fIfont_spacing_code\fP -3 tight .. 0 .. 3 spaced 
.br
\fIparagraph_setup\fP free text blocks or boxed in columns 
.br
\fIslicing_threshold\fP percent of line fill to cut fonts 
.br
\fIslicing_width\fP what is a wide font 
.br
\fIdir\fP true-ltr false-rtl 
.br
\fIhtml\fP output format is html 
.br
\fIfont_code\fP code for the font to use 
.br
\fInikud\fP recognize nikud in image 
.br
\fIprogress\fP a progress indicator 0..100 
.RE
.PP
\fBReturns:\fP
.RS 4
FALSE 
.RE
.PP

.SS "int hocr_do_ocr (const \fBho_pixbuf\fP * pix_in, \fBho_string\fP * s_text_out, const unsigned char html, int font_code, const unsigned char do_linguistics, int * progress)"
.PP
do ocr on a pixbuf, using default values
.PP
\fBParameters:\fP
.RS 4
\fIpix_in\fP the input \fBho_pixbuf\fP 
.br
\fIs_text_out\fP the text buffer to fill 
.br
\fIhtml\fP output format is html 
.br
\fIfont_code\fP code for the font to use 
.br
\fIprogress\fP a progress indicator 0..100 
.RE
.PP
\fBReturns:\fP
.RS 4
FALSE 
.RE
.PP

.SS "const char* hocr_get_build_string ()"
.PP
return the build string
.PP
\fBReturns:\fP
.RS 4
build string 
.RE
.PP

.PP
Referenced by hocr::Hocr::get_build_string().
.SS "const char* hocr_get_version_string ()"
.PP
return the version string
.PP
\fBReturns:\fP
.RS 4
version string 
.RE
.PP

.SH "Author"
.PP 
Generated automatically by Doxygen for libhocr from the source code.
